/*******************************************************************************
 * The MOSES project, model based software engineering of networked embedded systems.
 * 
 * Copyright (C) 2010-2013, University of Applied Sciences Wildau,
 * Telematics Research Group, http://www.tm.th-wildau.de/research-group
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 3 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see <http://www.gnu.org/licenses>.
 * 
 * Contributors:
 *     University of Applied Sciences Wildau - initial API and implementation
 * 
 * If you are interested in a commercial license please contact us via 
 * e-mail: ralf.vandenhouten@th-wildau.de.
 ******************************************************************************/
package de.thwildau.tm.moses.asn1.util;

import org.eclipse.xtext.naming.QualifiedName;
 
/**
 * Common interface of a Resource description for EObject. That description contains information about
 * about the EObject's resource that are useful for code generation.
 *
 * @author Thomas Kistel
 * @version $Revision: 763 $
 *
 * @param <T> the type of the EObject
 */
public interface EObjectResourceDescription<T> {
    
//    public static enum Language {
//        Java
//    }
    
    /**
     * Return the EObject that belongs to this resource description. 
     * 
     * @return the EObject that belongs to this resource description
     */
    public T getObject();
    
    /**
     * Returns the packageName for the EObject. Returns <code>null</code> if the EObject is not
     * in a package.
     * 
     * @return the packageName for the EObject or <code>null</code>
     */
    public QualifiedName getPackageName();
    
    /**
     * Returns the class name of the EObject.
     * 
     * @return the class name of the EObject
     */
    public String getClassName();
    
    /**
     * Return the full qualified name of the EObject. Usually this is the package name
     * plus the name of the EObject.
     * 
     * @return the full qualified name of the EObject
     */
    public QualifiedName getFullQualifiedName();
    
    /**
     * Returns the file path of the EObject. Usually the file path corresponds with the 
     * {@link #getFullQualifiedName()}. For the Java language the file of an EObject
     * with the qualified name <code>org.example.Test</code> is <code>org/example/Test.java</code>.
     * 
     * @param lang the target language for the file path
     * @return the file path of the EObject
     */
    public String getFilePath();
//    public String getFilePath(Language lang);
}
